package cn.z2huo.core.lang;

import cn.hutool.core.date.SystemClock;
import cn.hutool.core.lang.Assert;
import cn.hutool.core.lang.Pair;
import cn.hutool.core.util.RandomUtil;
import cn.hutool.core.util.StrUtil;
import cn.z2huo.core.lang.id.IdConstants;

import java.io.Serial;
import java.io.Serializable;
import java.time.LocalDateTime;
import java.time.ZoneId;

/**
 * <p>雪花算法
 *
 * @author z2huo
 */
public class Snowflake implements Serializable {

    @Serial
    private static final long serialVersionUID = -5069733862695364822L;

    /**
     * <p>默认的起始时间：2024-04-09T18:54+08:00[Asia/Shanghai]
     * <p>Instant.ofEpochMilli(1712660040000L).atZone(ZoneId.of("Asia/Shanghai"))
     */
    public static long DEFAULT_EPOCH = 1712660040000L;

    /**
     * 默认回拨时间，2 秒
     */
    public static long DEFAULT_TIME_OFFSET = 2000L;

    /**
     * 默认机器节点数量 bit 位数
     */
    private static final long WORKER_ID_BITS = 5L;

    /**
     * 最大支持机器节点数 0~31，共 32 个
     */
    @SuppressWarnings({"PointlessBitwiseExpression", "FieldCanBeLocal"})
    // 异或操作，如果相对应位值相同，则结果为0，否则为1
    // -1L 1111111111111111111111111111111111111111111111111111111111111111
    // -1L 左移 5 位，1111111111111111111111111111111111111111111111111111111111100000
    // 异或 计算结果为，0000000000000000000000000000000000000000000000000000000000011111，31
    public static final long MAX_WORKER_ID = -1L ^ (-1L << WORKER_ID_BITS);

    /**
     * 默认数据中心节点数量 bit 位数
     */
    private static final long DATA_CENTER_ID_BITS = 5L;

    /**
     * 最大支持数据中心节点数 0~31，一共 32 个
     */
    @SuppressWarnings({"PointlessBitwiseExpression", "FieldCanBeLocal"})
    public static final long MAX_DATA_CENTER_ID = -1L ^ (-1L << DATA_CENTER_ID_BITS);

    /**
     * 序列号 bit 位数，12位（表示只允许 workId 的范围为：0-4095）
     */
    private static final long SEQUENCE_BITS = 12L;

    /**
     * 机器节点左移 12 位
     */
    private static final long WORKER_ID_SHIFT = SEQUENCE_BITS;

    /**
     * 数据中心节点左移 17 位
     */
    private static final long DATA_CENTER_ID_SHIFT = SEQUENCE_BITS + WORKER_ID_BITS;

    /**
     * 时间毫秒数左移 22 位
     */
    private static final long TIMESTAMP_LEFT_SHIFT = SEQUENCE_BITS + WORKER_ID_BITS + DATA_CENTER_ID_BITS;

    /**
     * <p>序列掩码，用于限定序列最大值不能超过 4095
     * <p>4095
     */
    private static final long SEQUENCE_MASK = ~(-1L << SEQUENCE_BITS);

    /**
     * 初始化时间点
     */
    private final long epoch;

    /**
     * 初始化机器 ID
     */
    private final long workerId;

    /**
     * 初始化数据中心 ID
     */
    private final long dataCenterId;

    /**
     * <p>是否使用 SystemClock 中的时间
     * <p>SystemClock 为 hutool 自定义的获取当前时间工具
     */
    private final boolean useSystemClock;

    /**
     * 允许的时钟回拨毫秒数
     */
    private final long timeOffset;

    /**
     * <p>当在低频模式下时，序号始终为 0，导致生成 ID 始终为偶数
     * 此属性用于限定一个随机上限，在不同毫秒下生成序号时，给定一个随机数，避免偶数问题。
     *
     * <p>注意次数必须小于 {@link #SEQUENCE_MASK}，{@code 0}表示不使用随机数。
     *
     * <p>这个上限不包括值本身。
     */
    private final long randomSequenceLimit;

    /**
     * 自增序号，当高频模式下时，同一毫秒内生成 N 个 ID，则这个序号在同一毫秒下，自增以避免 ID 重复。
     */
    private long sequence = 0L;

    private long lastTimestamp = -1L;

    // region 构造方法

    /**
     * 使用自动生成的工作节点 ID 和数据中心 ID
     */
    public Snowflake() {
        this(IdConstants.DEFAULT_WORKER_ID);
    }

    /**
     *
     * @param workerId 终端ID
     */
    public Snowflake(long workerId) {
        this(workerId, IdConstants.DEFAULT_DATACENTER_ID);
    }

    /**
     * @param workerId     终端ID
     * @param dataCenterId 数据中心ID
     */
    public Snowflake(long workerId, long dataCenterId) {
        this(workerId, dataCenterId, false);
    }

    /**
     *
     * @param workerId         终端ID
     * @param dataCenterId     数据中心ID
     * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳
     */
    public Snowflake(long workerId, long dataCenterId, boolean isUseSystemClock) {
        this(null, workerId, dataCenterId, isUseSystemClock);
    }

    /**
     *
     * @param epochDate        初始化时间起点（null 表示默认起始日期）,后期修改会导致 id 重复,如果要修改连 workerId dataCenterId，慎用
     * @param workerId         工作机器节点 id
     * @param dataCenterId     数据中心 id
     * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳
     * @since 5.1.3
     */
    public Snowflake(LocalDateTime epochDate, long workerId, long dataCenterId, boolean isUseSystemClock) {
        this(epochDate, workerId, dataCenterId, isUseSystemClock, DEFAULT_TIME_OFFSET);
    }

    /**
     *
     * @param epochDate        初始化时间起点（null表示默认起始日期）,后期修改会导致id重复,如果要修改连workerId dataCenterId，慎用
     * @param workerId         工作机器节点id
     * @param dataCenterId     数据中心id
     * @param isUseSystemClock 是否使用{@link SystemClock} 获取当前时间戳
     * @param timeOffset       允许时间回拨的毫秒数
     * @since 5.8.0
     */
    public Snowflake(LocalDateTime epochDate, long workerId, long dataCenterId, boolean isUseSystemClock, long timeOffset) {
        this(epochDate, workerId, dataCenterId, isUseSystemClock, timeOffset, 0);
    }

    /**
     *
     * @param epochDate           初始化时间起点（null表示默认起始日期）,后期修改会导致id重复,如果要修改连workerId dataCenterId，慎用
     * @param workerId            工作机器节点id
     * @param dataCenterId        数据中心id
     * @param isUseSystemClock    是否使用{@link SystemClock} 获取当前时间戳
     * @param timeOffset          允许时间回拨的毫秒数
     * @param randomSequenceLimit 限定一个随机上限，在不同毫秒下生成序号时，给定一个随机数，避免偶数问题，0 表示无随机，上限不包括值本身。
     * @since 5.8.0
     */
    public Snowflake(LocalDateTime epochDate, long workerId, long dataCenterId,
                     boolean isUseSystemClock, long timeOffset, long randomSequenceLimit) {
        this.epoch = (null != epochDate) ? epochDate.atZone(ZoneId.of("Asia/Shanghai")).toInstant().toEpochMilli() : DEFAULT_EPOCH;
        this.workerId = Assert.checkBetween(workerId, 0, MAX_WORKER_ID);
        this.dataCenterId = Assert.checkBetween(dataCenterId, 0, MAX_DATA_CENTER_ID);
        this.useSystemClock = isUseSystemClock;
        this.timeOffset = timeOffset;
        this.randomSequenceLimit = Assert.checkBetween(randomSequenceLimit, 0, SEQUENCE_MASK);
    }

    // endregion

    // region 根据 ID 获取分段信息

    /**
     * 根据 Snowflake 的 ID，获取机器 id
     *
     * @param id snowflake算法生成的id
     * @return 所属机器的id
     */
    public long getWorkerId(long id) {
        // id >> WORKER_ID_SHIFT，将 id 中用来存储 work id 的部分移动到最低位
        // -1L 的二进制表示为 1111111111111111111111111111111111111111111111111111111111111111
        // -1L 左移 work id 会保存的长度，按位左移，低位补 0，1111111111111111111111111111111111111111111111111111111111100000
        // ~ 按位非，各个位置上 1 变成 0， 0 变成 1， 结果为 0000000000000000000000000000000000000000000000000000000000011111
        // 之后使用 按位与 操作符，只有位上都为 1 时，结果为 1，否则为 0，计算得出 work id
        return id >> WORKER_ID_SHIFT & ~(-1L << WORKER_ID_BITS);
    }

    /**
     * 根据 Snowflake 的 ID，获取数据中心 id
     *
     * @param id snowflake算法生成的id
     * @return 所属数据中心
     */
    public long getDataCenterId(long id) {
        return id >> DATA_CENTER_ID_SHIFT & ~(-1L << DATA_CENTER_ID_BITS);
    }

    /**
     * 根据 Snowflake 的 ID，获取生成时间
     *
     * @param id snowflake 算法生成的 id
     * @return 生成的时间
     */
    public long getGenerateDateTime(long id) {
        return (id >> TIMESTAMP_LEFT_SHIFT & ~(-1L << 41L)) + epoch;
    }

    // endregion

    /**
     * 根据传入时间戳-计算 ID 起终点
     *
     * @param timestampStart 开始时间戳
     * @param timestampEnd   结束时间戳
     * @return key-ID起点，Value-ID终点
     * @since 5.8.23
     */
    public Pair<Long, Long> getIdScopeByTimestamp(long timestampStart, long timestampEnd) {
        return getIdScopeByTimestamp(timestampStart, timestampEnd, true);
    }

    /**
     * 根据传入时间戳-计算ID起终点 Gitee/issues/I60M14
     *
     * @param timestampStart        开始时间戳
     * @param timestampEnd          结束时间戳
     * @param ignoreCenterAndWorker 是否忽略数据中心和机器节点的占位，忽略后可获得分布式环境全局可信赖的起终点。
     * @return key-ID起点，Value-ID终点
     */
    public Pair<Long, Long> getIdScopeByTimestamp(long timestampStart, long timestampEnd, boolean ignoreCenterAndWorker) {
        long startTimeMinId = (timestampStart - epoch) << TIMESTAMP_LEFT_SHIFT;
        long endTimeMinId = (timestampEnd - epoch) << TIMESTAMP_LEFT_SHIFT;
        if (ignoreCenterAndWorker) {
            long endId = endTimeMinId | ~(-1 << TIMESTAMP_LEFT_SHIFT);
            return Pair.of(startTimeMinId, endId);
        } else {
            long startId = startTimeMinId | (dataCenterId << DATA_CENTER_ID_SHIFT) | (workerId << WORKER_ID_SHIFT);
            long endId = endTimeMinId | (dataCenterId << DATA_CENTER_ID_SHIFT) | (workerId << WORKER_ID_SHIFT) | SEQUENCE_MASK;
            return Pair.of(startId, endId);
        }
    }

    // region 获取 ID

    /**
     * 获取下一个 ID（long 类型）
     */
    public synchronized long nextId() {
        long timestamp = genTime();
        // 如果获取到的当前时间小于上一次生成 ID 的时间
        if (timestamp < this.lastTimestamp) {
            // 如果差值小于 允许的时钟回拨毫秒数（默认 2 秒）
            if (this.lastTimestamp - timestamp < timeOffset) {
                // 容忍指定的回拨，避免 NTP 校时造成的异常
                timestamp = lastTimestamp;
            } else {
                // 如果服务器时间有问题(时钟后退) 报错。
                throw new IllegalStateException(StrUtil.format("Clock moved backwards. Refusing to generate id for {} ms", lastTimestamp - timestamp));
            }
        }

        // 如果获取到的当前时间等于上一次生成 ID 的时间
        if (timestamp == this.lastTimestamp) {
            final long sequence = (this.sequence + 1) & SEQUENCE_MASK;
            // sequence 为 0，因为 timestamp == this.lastTimestamp 表示当前毫秒已经生成过 ID 了，此 0 不可能为第一次生成时的 0
            // 只可能是 sequence 为 4096 时，序号 4096（二进制 1000000000000）与 4095（二进制 11111111111）按位与运算计算结果完成后的 0
            // 此时生成的需要已经超过了 4095，超过了 12 bit 位的序号位数限制
            if (sequence == 0) {
                // 时间重新赋值，知道 timestamp 大于 lastTimestamp 最后生成序号时间为止
                timestamp = this.tilNextMillis(lastTimestamp);
            }
            this.sequence = sequence;
        } else {
            // issue#I51EJY
            // 当在低频模式下时，序号始终为 0，导致生成 ID 始终为偶数
            // randomSequenceLimit 用于限定一个随机上限，在不同毫秒下生成序号时，给定一个随机数，避免偶数问题。
            // 默认构造器中，randomSequenceLimit 属性赋值为 0，表示不需要随机数
            if (randomSequenceLimit > 1) {
                sequence = RandomUtil.randomLong(randomSequenceLimit);
            } else {
                sequence = 0L;
            }
        }

        // 最后一次生成 ID 时间重新赋值
        lastTimestamp = timestamp;

        // 组装 ID
        return ((timestamp - epoch) << TIMESTAMP_LEFT_SHIFT)
                | (dataCenterId << DATA_CENTER_ID_SHIFT)
                | (workerId << WORKER_ID_SHIFT)
                | sequence;
    }

    /**
     * 下一个 ID（String 类型）
     */
    public String nextIdStr() {
        return Long.toString(nextId());
    }

    // endregion

    // region private methods

    /**
     * 循环等待下一个时间
     *
     * @param lastTimestamp 上次记录的时间
     * @return 下一个时间
     */
    private long tilNextMillis(long lastTimestamp) {
        long timestamp = genTime();
        // 循环直到操作系统时间戳变化
        while (timestamp == lastTimestamp) {
            timestamp = genTime();
        }
        if (timestamp < lastTimestamp) {
            // 如果发现新的时间戳比上次记录的时间戳数值小，说明操作系统时间发生了倒退，报错
            throw new IllegalStateException(
                    StrUtil.format("Clock moved backwards. Refusing to generate id for {}ms", lastTimestamp - timestamp));
        }
        return timestamp;
    }

    /**
     * 生成时间戳
     *
     * @return 时间戳
     */
    private long genTime() {
        return this.useSystemClock ? SystemClock.now() : System.currentTimeMillis();
    }

    // endregion

}
